IApi.WriteAxisTargetPosition method

Sets the target position of an axis.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB
KsError WriteAxisTargetPosition(
       int Index,
       int Value
)
Function WriteAxisTargetPosition(
       Index As Integer,
       Value As Integer
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

 

Value

Type: int

The target position of the axis in user unit.

Return value

Type: KsError

A return code of a method.

Remarks

This function can be used only in Manual mode. See the McControlMode enum.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace